Skip to content

Fix spelling of "Garrote"#438

Merged
rgommers merged 1 commit intoPyWavelets:masterfrom
grlee77:garrote_spelling
Nov 26, 2018
Merged

Fix spelling of "Garrote"#438
rgommers merged 1 commit intoPyWavelets:masterfrom
grlee77:garrote_spelling

Conversation

@grlee77
Copy link
Copy Markdown
Contributor

@grlee77 grlee77 commented Nov 26, 2018

The "non-negative Garrote" threshold mode was misspelled "Garotte" instead of "Garrote" in some places. This PR fixes these.
(see https://www.jstor.org/stable/1269730 as a reference for Garrote being the correct spelling)

Unfortunately, one of these was in the mode argument to pywt.threshold. To avoid breaking any existing code, In this PR I chose to just allow either spelling (mode='garrote' or 'mode='garotte') to be used but to only document the correct spelling in the docstring. If desired, I could add a deprecation warning for the incorrectly spelled variant.

@rgommers rgommers merged commit 7fdf5d1 into PyWavelets:master Nov 26, 2018
@rgommers
Copy link
Copy Markdown
Member

Thanks, merged. I agree with the mapping in this PR, no deprecation warning necessary I think.

@rgommers rgommers added this to the v1.1 milestone Nov 26, 2018
@grlee77 grlee77 deleted the garrote_spelling branch November 13, 2019 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants